Use - Oriented Documentation in Software Development
نویسنده
چکیده
Software documentation is an important tool in modern component-based programming. Building software applications requires detailed knowledge about a vast number of components and the structures they form. This knowledge is often acquired by reading reference documentation of application-programming interfaces (APIs). Thus, the design of the API reference documentation and its reading support affect the cost and quality of software de-
منابع مشابه
Initial Development and Testing of a State-of-the-Art Method to Quantify Hydrologic Model Uncertainty
INTRODUCTION: To support the US Army Corps of Engineers’(USACE) use of risk-based analysis in flood damage reduction studies, Skahill (2012) identified the most promising state-ofthe-art and practice-oriented approaches to robustly quantify hydrologic and hydraulic (H&H) model uncertainty. Skahill (2012) provides a path forward for related work activities, including software development, prepar...
متن کاملA Declarative Meta-Programming Approach to Framework Documentation
The documentation of software artifacts in general, and object-oriented frameworks in particular, has always been problematic. In this paper, we advocate the use of a declarative meta-programming environment to document software artifacts. In particular, we show how a significant and important part of the design of a framework can be adequately and concisely documented in such an environment, a...
متن کاملXML to Manage Source Engineering in Object-Oriented Development: an Example
In software engineering, XML to date has mostly been used to support three sub-activities: documentation management, data interchange and lightweight data storage. In this position paper, we give an example of using XML technology as the infrastructure for the integrated management of all core software development information. For several years now we have been developing the concept of Design ...
متن کاملToward Single-sourcing of Project Documentation: A Preliminary Study
Project documentation is a requisite task to the success of a software development project. Project documentation strings up the context of development for a software project. However, preparing, writing and maintaining project documents are often considered a tedious and fragmental job, especially in the rapid project development with the stress of time. With the aim at achieving single sourci...
متن کاملImproving Program Comprehension of Object-oriented Software Systems with Object-oriented Documentation
Object-oriented programming has brought many advantages to the software engineering community. Especially, the reuse of existing software components and application frameworks has improved the productivity in software development considerably. Now, the object-oriented programming paradigm has advanced in years and increasingly object-oriented software systems have to be maintained. Program comp...
متن کاملذخیره در منابع من
با ذخیره ی این منبع در منابع من، دسترسی به آن را برای استفاده های بعدی آسان تر کنید
عنوان ژورنال:
دوره شماره
صفحات -
تاریخ انتشار 1999